Dataset

[POST] /api/v2/data/datasets/{id}/export

导出数据集文档。

参数:

名称	类型	位置	描述
id必填项	string	path	数据集文档 ID。例如：4d4dc304-8ae5-16e4-c790-a8b87a7246b2

请求数据格式

DatasetExportModel

返回值

状态码: 200

成功

binary

状态码: 400

错误的请求

DatasetPluginErrorV2

[PUT] /api/v2/data/datasets/cached-datasets/batch-refresh

批量刷新数据集数据。

请求数据格式

BatchRefreshDatasetRequestModel

返回值

状态码: 200

成功

BatchRefreshDatasetTaskResultModel

状态码: 400

错误的请求

DatasetPluginErrorV2

[GET] /api/v2/data/datasets/{id}/download

下载数据集文档。

参数:

名称	类型	位置	描述
id必填项	string	path	文档编号。例如：15fd3940-e83c-19d7-246d-81b2ccb7e195

返回值

状态码: 200

成功

binary

状态码: 400

错误的请求

DatasetPluginErrorV2

状态码: 404

未找到

DatasetPluginErrorV2

[GET] /api/v2/data/datasets/cached-datasets/list

获取所有缓存数据集

返回值

状态码: 200

成功

DatasetCachesResultModel

状态码: 400

错误的请求

DatasetPluginErrorV2

[GET] /api/v2/data/datasets/cached-datasets/cache-infos

获取所有缓存数据集

参数:

名称	类型	位置	描述
pageSize	int32	query	每页显示的数据数。 -1表示所有数据。
pageNumber	int32	query	当前页码。从 1 开始。
orderBy	string	query	指示数据按哪一列排序。
search	string	query	名称过滤器。
invalid	Boolean	query	是否只显示无效数据。

返回值

状态码: 200

成功

DatasetCachesListResultModel

状态码: 400

错误的请求

DatasetPluginErrorV2

[POST] /api/v2/data/datasets/push-datasets/{id}/append-data

按id添加推送数据集数据。

参数:

名称	类型	位置	描述
id必填项	string	path	数据集 ID。例如：96f08381-f07c-3b0f-5f43-e84491b1616b
pushDataToken	string	query	推送数据令牌

请求数据格式

InsertPushDataModel

返回值

状态码: 204

无内容

状态码: 400

错误的请求

DatasetPluginErrorV2

[POST] /api/v2/data/datasets/push-datasets/{id}/clear-data

根据条件删除推送数据集的数据。

参数:

名称	类型	位置	描述
id必填项	string	path	数据集 ID。例如：96f08381-f07c-3b0f-5f43-e84491b1616b
pushDataToken	string	query	推送数据令牌

请求数据格式

ClearPushDataModel

返回值

状态码: 204

无内容

状态码: 400

错误的请求

DatasetPluginErrorV2

[POST] /api/v2/data/datasets/streaming-datasets/{id}/append-data

通过id添加流式数据集数据。

参数:

名称	类型	位置	描述
id必填项	string	path	数据集 ID。例如：006fa63d-2b21-0433-5785-9c8751dba0b4
pushDataToken	string	query	推送数据令牌

请求数据格式

InsertStreamingDataModel

返回值

状态码: 204

无内容

状态码: 400

错误的请求

DatasetPluginErrorV2

[GET] /api/v2/data/datasets/{id}/query

查询数据集。

参数:

名称	类型	位置	描述
id必填项	string	path	数据集ID
query	string	query	查询
queryType	string	query	查询类型
format	string	query	格式
UnknownTypeHandle	string	query	未知类型处理方式
MissParameterHandle	string	query	缺少参数处理方式
RowLimit	string	query	行限制

返回值

状态码: 200

成功

binary

状态码: 400

错误的请求

DatasetPluginErrorV2

状态码: 404

未找到

DatasetPluginErrorV2

[POST] /api/v2/data/datasets/{id}/query

查询数据集。

参数:

名称	类型	位置	描述
id必填项	string	path	数据集ID

请求数据格式

QueryDataSetRequestBody

返回值

状态码: 200

成功

binary

状态码: 400

错误的请求

DatasetPluginErrorV2

状态码: 404

未找到

DatasetPluginErrorV2

类型定义

Ƭ DatasetPluginErrorV2

数据集插件错误模型

名称	类型	描述	示例
code可为空	string	错误代码
message可为空	string	错误信息
context可为空	string	错误上下文
innerError	DatasetPluginErrorV2
extendedResult可为空	any	扩展结果

Ƭ DatasetExportModel

表示数据集导出模型。

名称	类型	描述	示例
parameters可为空	DatasetParameterItem	获取或设置数据集导出参数。
advancedSetting	ExportAdvancedSetting
fileType可为空	string	获取或设置数据集导出文件类型。	"JSON"

Ƭ DatasetParameterItem

表示一个数据集参数项。

名称	类型	描述	示例
name可为空	string	获取或设置数据集导出参数名称。	"age"
value可为空	Array	获取或设置数据集导出参数值。	[18,21]

Ƭ ExportAdvancedSetting

表示数据集导出高级设置。

名称	类型	描述	示例
encoding可为空	string	获取或设置 csv 文件编码。	"utf-8"
noHeader	Boolean	获取或设置 csv 文件是否有标题。	true
columnsDelimiter可为空	string	获取或设置 csv 文件列分隔符。	","
rowsDelimiter可为空	string	获取或设置 csv 文件行分隔符。	";"
formatted	Boolean	获取或设置json文件是否格式化。	true
quotePropertyNames	Boolean	获取或设置 json 文件引用属性名称。	true
limit	int32	获取或设置文件限制大小。	100

Ƭ BatchRefreshDatasetTaskResultModel

表示批量刷新任务的结果模型。

名称	类型	描述	示例
datasetId可为空	string	获取或设置数据集文档 ID。
success	Boolean	获取或设置批量刷新任务的结果。
errorCode可为空	string	获取或设置任务失败时的错误代码。
errorMessage可为空	string	获取或设置任务失败时的错误消息。
taskId可为空	string	获取或设置批量刷新任务id。

Ƭ BatchRefreshDatasetRequestModel

表示批量刷新模型。

名称	类型	描述	示例
refreshDataSetIds	Array<string>	获取或设置刷新数据集 ID。	["789ACE15-1C11-DFD0-312D-AA32EBA0AB67","51FC17FF-D490-42E1-D419-E7BBC83CCF53"]
cotSearchEntryInfos可为空	SearchEntryInfo	获取或设置 COT 搜索条目信息。

Ƭ SearchEntryInfo

表示一个COT搜索条目信息。

名称	类型	描述	示例
tenantId可为空	string	获取或设置租户 ID。	"D2DA4850-FBD0-7022-E471-E3AEDAA140E3"
datasetId可为空	string	获取或设置数据集 ID。	"E2DD8243-8CD3-39F7-8FAE-E23E6AE0ECF2"

Ƭ DatasetCachesResultModel

表示获取数据集缓存的结果模型。

名称	类型	描述	示例
lastErrorData可为空	string	数据集缓存上次刷新错误数据。
datasetId可为空	string	数据集文档 ID。
title可为空	string	数据集文档标题。
displayName可为空	string	数据集缓存显示名称。
creatorName可为空	string	数据集文档创建者名称。
tenantId可为空	string	租户 ID。
rowCount	int64	数据集缓存数据行计数。
operation可为空	string	数据集缓存操作。
lastUpdated可为空	ISO DateTime Sting	数据集缓存上次更新时间。

Ƭ DatasetCachesListResultModel

表示获取数据集缓存的结果模型。

名称	类型	描述	示例
datasetQueryInfos可为空	DatasetCacheListQueryInfo	数据集查询信息列表。
pagination	PaginationInfo

Ƭ DatasetCacheListQueryInfo

表示数据集查询信息列表。

名称	类型	描述	示例
datasetId可为空	string	数据集文档 ID。
title可为空	string	数据集文档标题。
displayName可为空	string	数据集缓存显示名称。
creatorName可为空	string	数据集文档创建者名称。
tenantId可为空	string	租户 ID。
rowCount	int64	数据集缓存数据行计数。
operation可为空	string	数据集缓存操作。
lastUpdated可为空	ISO DateTime Sting	数据集缓存上次更新时间。
lastErrorData可为空	string	数据集缓存上次刷新错误数据。

Ƭ PaginationInfo

代表分页信息。

名称	类型	描述	示例
pageSize	int32	每页数据计数。
pageNumber	int32	当前页码。
total	int32	数据总数。

Ƭ InsertPushDataModel

添加推送数据集数据

名称	类型	描述	示例
columns	Array<string>	推送数据集数据列	["id","name"]
rows	Array<array>	推送数据集数据行	[[0,"Lisa"],[1,"Bob"]]
overwrite	Boolean	是否完全覆盖旧数据	true

Ƭ ClearPushDataModel

清除推送数据集数据

名称	类型	描述	示例
columnName可为空	string	推送数据集数据列名称	"name"
value可为空	any	推送数据集数据列值	"Lisa"
option可为空	string	用于 where 子句的选项。支持>、<、=	"="

Ƭ InsertStreamingDataModel

添加推送数据集数据

名称	类型	描述	示例
columns	Array<string>	流式数据集数据列	["id","name"]
rows	Array<array>	流式数据集数据行	[[0,"Lisa"],[1,"Bob"]]
overwrite	Boolean	是否完全覆盖旧数据	true

Ƭ QueryDataSetRequestBody

查询数据集请求体

名称	类型	描述	示例
datasetParameters可为空	string	数据源参数
query可为空	string	查询
queryType可为空	string	查询类型
format可为空	string	格式
options	Options

Ƭ Options

名称	类型	描述	示例
unknownTypeHandle可为空	string	未知类型处理方式
missParameterHandle可为空	string	缺少参数处理方式
rowLimit可为空	string	行限制